doc(Modbus): update IModbusResponse Buffer doc #6780
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
Reviewer's guide (collapsed on small PRs)Reviewer's GuideThis PR refactors the Modbus sample documentation by renaming the IModbusResponse RawData property to Buffer, updates all related code snippets and doc text accordingly, and corrects the benchmark memory allocation figure. Class diagram for updated IModbusResponse interfaceclassDiagram
class IModbusResponse {
+ReadOnlyMemory<byte> Buffer
+IModbusMessageBuilder Builder
}
IModbusResponse --> IModbusMessageBuilder
File-Level Changes
Assessment against linked issues
Possibly linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR updates documentation for the Modbus module to reflect changes in the IModbusResponse interface, where the RawData property has been renamed to Buffer. It also updates package references to newer versions.
- Updates documentation to use the new
Bufferproperty name instead ofRawData - Updates Longbow.Modbus from 9.0.9 to 9.0.10 and Longbow.TcpSocket from 9.0.11 to 9.0.12
- Minor formatting cleanup in benchmark results table
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| ModbusFactories.razor | Updates interface documentation and usage examples to reference Buffer instead of RawData property |
| BootstrapBlazor.Server.csproj | Updates Longbow.Modbus and Longbow.TcpSocket package versions |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
src/BootstrapBlazor.Server/Components/Samples/Modbus/ModbusFactories.razor
Outdated
Show resolved
Hide resolved
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Hey there - I've reviewed your changes - here's some feedback:
- The warning paragraph still refers to
RawData—please update it toBufferto stay consistent with the property rename. - Since renaming
RawDatatoBufferis a breaking change, consider adding a migration note or deprecation guide so users know how to update their code. - Double-check that the updated performance table still renders correctly as a preformatted block in the Razor sample (the closing tag was moved inline).
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- The warning paragraph still refers to `RawData`—please update it to `Buffer` to stay consistent with the property rename.
- Since renaming `RawData` to `Buffer` is a breaking change, consider adding a migration note or deprecation guide so users know how to update their code.
- Double-check that the updated performance table still renders correctly as a preformatted block in the Razor sample (the closing </Pre> tag was moved inline).Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #6780 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 739 739
Lines 31721 31721
Branches 4464 4464
=========================================
Hits 31721 31721
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Link issues
fixes #6779
Summary By Copilot
Regression?
Risk
Verification
Packaging changes reviewed?
☑️ Self Check before Merge
Summary by Sourcery
Update the Modbus sample documentation and benchmarks to reflect renaming the IModbusResponse RawData property to Buffer and correct the reported memory allocation.
Enhancements:
Documentation: